<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>netLink C++ 11: include/netLink.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">netLink C++ 11
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">netLink.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">    netLink: c++ 11 networking library</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">    Copyright (C) 2013-2023 Alexander Meißner</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">    This program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">    it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">    the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment">    (at your option) any later version.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">    This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">    GNU General Public License for more details.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"></span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">    You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment">    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;MsgPackSocket.h&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="keyword">namespace </span>netLink {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classnet_link_1_1_socket_manager.html">   26</a></span>    <span class="keyword">class </span><a class="code hl_class" href="classnet_link_1_1_socket_manager.html">SocketManager</a> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>        <span class="keyword">public</span>:</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classnet_link_1_1_socket_manager.html#a47427d4f7356e251a215d2d961bab5d6">   29</a></span>        std::function&lt;bool(<a class="code hl_class" href="classnet_link_1_1_socket_manager.html">SocketManager</a>* manager, std::shared_ptr&lt;Socket&gt; serverSocket, std::shared_ptr&lt;Socket&gt; clientSocket)&gt; <a class="code hl_variable" href="classnet_link_1_1_socket_manager.html#a47427d4f7356e251a215d2d961bab5d6">onConnectRequest</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="classnet_link_1_1_socket_manager.html#a5d5f02bcb1957cfd4b0404d8bc72b365">   31</a></span>        std::function&lt;void(<a class="code hl_class" href="classnet_link_1_1_socket_manager.html">SocketManager</a>* manager, std::shared_ptr&lt;Socket&gt; socket, <a class="code hl_enumeration" href="classnet_link_1_1_socket.html#a97d865489970e8bad3122107b819292e">Socket::Status</a> prev)&gt; <a class="code hl_variable" href="classnet_link_1_1_socket_manager.html#a5d5f02bcb1957cfd4b0404d8bc72b365">onStatusChange</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classnet_link_1_1_socket_manager.html#a45ab601570cf50d5f8ec2b11d99bbe37">   33</a></span>        std::function&lt;void(<a class="code hl_class" href="classnet_link_1_1_socket_manager.html">SocketManager</a>* manager, std::shared_ptr&lt;Socket&gt; socket)&gt; <a class="code hl_variable" href="classnet_link_1_1_socket_manager.html#a45ab601570cf50d5f8ec2b11d99bbe37">onReceiveRaw</a>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classnet_link_1_1_socket_manager.html#a08cc13db51c726ecd79137ebe6271361">   35</a></span>        std::function&lt;void(<a class="code hl_class" href="classnet_link_1_1_socket_manager.html">SocketManager</a>* manager, std::shared_ptr&lt;Socket&gt; socket, std::unique_ptr&lt;MsgPack::Element&gt; element)&gt; <a class="code hl_variable" href="classnet_link_1_1_socket_manager.html#a08cc13db51c726ecd79137ebe6271361">onReceiveMsgPack</a>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classnet_link_1_1_socket_manager.html#a9b80317fe10e46c787a2c24e2cef3a37">   37</a></span>        std::set&lt;std::shared_ptr&lt;Socket&gt;&gt; <a class="code hl_variable" href="classnet_link_1_1_socket_manager.html#a9b80317fe10e46c787a2c24e2cef3a37">sockets</a>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>        std::shared_ptr&lt;Socket&gt; <a class="code hl_function" href="classnet_link_1_1_socket_manager.html#a3302a5e748da545267ab80ae90b59e96">newSocket</a>();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>        std::shared_ptr&lt;Socket&gt; <a class="code hl_function" href="classnet_link_1_1_socket_manager.html#adc8e305b9267feb5f55f30f405d18af6">newMsgPackSocket</a>();</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>        <span class="keywordtype">void</span> <a class="code hl_function" href="classnet_link_1_1_socket_manager.html#ac34d812026b56162551cce9aedefe22c">listen</a>(<span class="keywordtype">double</span> waitUpToSeconds = 0.0);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>    };</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>};</div>
<div class="ttc" id="aclassnet_link_1_1_socket_html_a97d865489970e8bad3122107b819292e"><div class="ttname"><a href="classnet_link_1_1_socket.html#a97d865489970e8bad3122107b819292e">netLink::Socket::Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">Defines the send status of a socket.</div><div class="ttdef"><b>Definition</b> Socket.h:81</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html">netLink::SocketManager</a></div><div class="ttdoc">Manages a group of Sockets.</div><div class="ttdef"><b>Definition</b> netLink.h:26</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html_a08cc13db51c726ecd79137ebe6271361"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html#a08cc13db51c726ecd79137ebe6271361">netLink::SocketManager::onReceiveMsgPack</a></div><div class="ttdeci">std::function&lt; void(SocketManager *manager, std::shared_ptr&lt; Socket &gt; socket, std::unique_ptr&lt; MsgPack::Element &gt; element)&gt; onReceiveMsgPack</div><div class="ttdoc">Event which is called if a socket receives a MsgPack::Element.</div><div class="ttdef"><b>Definition</b> netLink.h:35</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html_a3302a5e748da545267ab80ae90b59e96"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html#a3302a5e748da545267ab80ae90b59e96">netLink::SocketManager::newSocket</a></div><div class="ttdeci">std::shared_ptr&lt; Socket &gt; newSocket()</div><div class="ttdoc">Allocates a new Socket, inserts it into sockets and returns it.</div><div class="ttdef"><b>Definition</b> SocketManager.cpp:49</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html_a45ab601570cf50d5f8ec2b11d99bbe37"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html#a45ab601570cf50d5f8ec2b11d99bbe37">netLink::SocketManager::onReceiveRaw</a></div><div class="ttdeci">std::function&lt; void(SocketManager *manager, std::shared_ptr&lt; Socket &gt; socket)&gt; onReceiveRaw</div><div class="ttdoc">Event which is called if a socket receives new raw data.</div><div class="ttdef"><b>Definition</b> netLink.h:33</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html_a47427d4f7356e251a215d2d961bab5d6"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html#a47427d4f7356e251a215d2d961bab5d6">netLink::SocketManager::onConnectRequest</a></div><div class="ttdeci">std::function&lt; bool(SocketManager *manager, std::shared_ptr&lt; Socket &gt; serverSocket, std::shared_ptr&lt; Socket &gt; clientSocket)&gt; onConnectRequest</div><div class="ttdoc">Event which is called if a TCP_SERVER accepts a new connection (if false is returned the connection w...</div><div class="ttdef"><b>Definition</b> netLink.h:29</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html_a5d5f02bcb1957cfd4b0404d8bc72b365"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html#a5d5f02bcb1957cfd4b0404d8bc72b365">netLink::SocketManager::onStatusChange</a></div><div class="ttdeci">std::function&lt; void(SocketManager *manager, std::shared_ptr&lt; Socket &gt; socket, Socket::Status prev)&gt; onStatusChange</div><div class="ttdoc">Event which is called if a socket can or can not send more data (also called if nonblocking connect s...</div><div class="ttdef"><b>Definition</b> netLink.h:31</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html_a9b80317fe10e46c787a2c24e2cef3a37"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html#a9b80317fe10e46c787a2c24e2cef3a37">netLink::SocketManager::sockets</a></div><div class="ttdeci">std::set&lt; std::shared_ptr&lt; Socket &gt; &gt; sockets</div><div class="ttdoc">Sockets which are managed.</div><div class="ttdef"><b>Definition</b> netLink.h:37</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html_ac34d812026b56162551cce9aedefe22c"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html#ac34d812026b56162551cce9aedefe22c">netLink::SocketManager::listen</a></div><div class="ttdeci">void listen(double waitUpToSeconds=0.0)</div><div class="ttdef"><b>Definition</b> SocketManager.cpp:61</div></div>
<div class="ttc" id="aclassnet_link_1_1_socket_manager_html_adc8e305b9267feb5f55f30f405d18af6"><div class="ttname"><a href="classnet_link_1_1_socket_manager.html#adc8e305b9267feb5f55f30f405d18af6">netLink::SocketManager::newMsgPackSocket</a></div><div class="ttdeci">std::shared_ptr&lt; Socket &gt; newMsgPackSocket()</div><div class="ttdoc">Allocates a new MsgPackSocket, inserts it into sockets and returns it.</div><div class="ttdef"><b>Definition</b> SocketManager.cpp:55</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
</small></address>
</body>
</html>
